RegionInfo

Members

It is one (not all) of the following types:

---

Subtype A

---

BeaconCount

The amount of beacons in the region at the time of the scan. It is of the type number.

---

HasRings

Whether the region has planetary rings. It is of the type boolean.

---

Name

The name of the region. It is of the type string.

---

TidallyLocked

This value contains meaningless data for a space region, but is nonetheless present. It is of the type boolean.

---

Type

It is always the string Planet.

---

Subtype B

---

BeaconCount

The amount of beacons in the region at the time of the scan. It is of the type number.

---

Color

The primary color of the planet. It is of the type Color3.

---

Gravity

The gravity of the planet. It is of the type number.

---

HasAtmosphere

Whether the planet has an atmosphere. It is of the type boolean.

---

HasRings

Whether the planet has planetary rings. It is of the type boolean.

---

Name

The name of the planet. It is of the type string.

---

Resources

The resources that can be found on the planet. It is an array whose values are of the type string.

---

SubType

The type of the planet, such as Desert, Terra, EarthLike, etc. It is of the type PlanetType.

---

TidallyLocked

Whether the planet is tidally locked, meaning, whether it has a day/night cycle. It is of the type boolean.

---

Type

It is always the string Planet.

---

Subtype C

---

BeaconCount

The amount of beacons in the region at the time of the scan. It is of the type number.

---

Name

The name of the region. It is of the type string.

---

Size

The visual size of the black hole. It is of the type number.

It ranges between 500 and 15000. It increments by 1.

---

Type

It is always the string BlackHole.

---

Subtype D

---

BeaconCount

The amount of beacons in the region at the time of the scan. It is of the type number.

---

Name

The name of the region. It is of the type string.

---

Size

The visual size of the star. It is of the type number.

It ranges between 2000 and 6000. It increments by 1.

---

SubType

The type of the star, such as Red, Orange, Yellow, etc. It is of the type StarType.

---

Type

It is always the string Star.

Luau Type

This is the luau type for RegionInfo. It may help clear up mistranslations from the raw data to the wiki page (as it is an automatic process).

export type RegionInfo = {
	BeaconCount: number,
	Type: "Planet",
	Name: string,
	HasRings: boolean,
	SubType: never,
	TidallyLocked: boolean,
} | {
	HasAtmosphere: boolean,
	Type: "Planet",
	Color: Color3,
	Gravity: number,
	SubType: PlanetType,
	BeaconCount: number,
	Name: string,
	Resources: { string },
	TidallyLocked: boolean,
	HasRings: boolean,
} | {
	BeaconCount: number,
	Type: "BlackHole",
	Name: string,
	Size: number,
} | {
	BeaconCount: number,
	Type: "Star",
	Name: string,
	SubType: StarType,
	Size: number,
}